794 lines (576 loc) · 20.5 KB

IQ Gateway API

Table of Contents

Introduction
General Documentation
Endpoints
- Admin
- Authentication
- Data Tables
- General
- Installer
- IVP
- Stream
- Version 1 API (Legacy)

Introduction

Enphase-API is an unofficial project providing an API wrapper and the documentation for Enphase®'s products and services.

More details on the project are available from the project’s homepage.

General Documentation

Name	Description
`Architecture`	How the system is designed.
`Authentication`	How authentication and authorisation works with the Local API.

Endpoints

Admin

Admin - Lib

Name	URI	Description
`AC Battery (ACB) Configuration`	`/admin/lib/acb_config.json`	Get, set or cancel an AC Battery’s (ACB) sleep mode.
`Administer Device Conditions and Controls (DCC)`	`/admin/lib/admin_dcc_display.json`	Send a Device Conditions and Controls (DCC) command, such as to clear a Ground Fault Interrupt (GFI).
`Administer Power Meter Unit (PMU)`	`/admin/lib/admin_pmu_display.json`	Add, read or remove a Power Meter Unit (PMU).
`Date and Time Settings`	`/admin/lib/date_time_display.json`	Get or set date, time and timezone.
`De-Bug Access (DBA)`	`/admin/lib/dba.json`	Get or set the Enphase® De-Bug Access (DBA) tunnel state.
`Network Configuration`	`/admin/lib/network_display.json`	Get/Set network information and/or perform network diagnostics.
`Security Configuration`	`/admin/lib/security_display.json`	Change password (legacy).
`Tariff Configuration`	`/admin/lib/tariff.json`	Get or set the tariff settings.
`Wireless Configuration`	`/admin/lib/wireless_display.json`	Get or set the wireless settings.

Authentication

Name	URI	Description
`Check JSON Web Token (JWT)`	`/auth/check_jwt`	Checks a user is authenticated and authorised.

Data Tables

Name	URI	Description
`Administer Device Conditions and Controls (DCC) DataTable`	`/datatab/admin_dcc_display_dt`	Used by the JavaScript datatable to return Device Conditions and Controls (DCC) records.
`Events DataTable`	`/datatab/event_dt.rb`	Used by the JavaScript datatable to return event log records.
`Inventory DataTable`	`/datatab/inventory_dt`	Used by the JavaScript datatable to return inventory records.

General

Name	URI	Description
`Home`	`/home.json`	Obtain a summary of the gateway status.
`Information`	`/info.xml`	Obtain an unauthenticated summary of the gateway’s software status.
`Inv`	`/inv`	Get the Electrical SUB-panels (ESUBs) status, also includes the "IQ System Controller" (formerly "Enpower") circuit board.
`Inventory`	`/inventory.json`	Lists the inventory of `PCU` (Power Conditioning Unit, also called a "microinverter"), `ACB` (AC Battery), `NSRB` (Network System Relay Breaker?, also called an "IQ Relay") and `ESUB` (Electrical SUB-panel, also called an "IQ System Controller" formerly "Enpower") devices.
`Production`	`/production.json`	Obtain production data.
`Provision`	`/prov`	Adds or deletes inverters.
`Upload`	`/upload`	Upload file package.

Installer

Installer - Advanced Grid Functionality (AGF)

Name	URI	Description
`Details`	`/installer/agf/details.json`	Get an Advanced Grid Functionality (AGF) profile.
`Index`	`/installer/agf/index.json`	List uploaded Advanced Grid Functionality (AGF) profile(s).
`Inverters Phase`	`/installer/agf/inverters_phase.rb`	List each inverter installed by phase.
`Inverters Status`	`/installer/agf/inverters_status.json` and `/installer/agf/inverters_status`	Get the Advanced Grid Functionality (AGF) profile status of each inverter and/or set its associated phase.
`Set Profile`	`/installer/agf/set_profile.json`	Set the Advanced Grid Functionality (AGF) profile.
`Upload Profile Package`	`/installer/agf/upload_profile_package`	Upload a new Advanced Grid Functionality (AGF) profile.

Installer - General

Name	URI	Description
`Power Conditioning Unit (PCU) Communication Check`	`/installer/pcu_comm_check`	Check communication with the Power Conditioning Unit(s) (PCU, also called "microinverter(s)").
`Secure SHell (SSH) Revoke List`	`/installer/ssh_revoke_list`	Get the list of Secure SHell (SSH) revoked keys.
`Upgrade Start`	`/installer/upgrade_start`	Start an upgrade of a gateway or Energy Management Unit (EMU).
`Upgrade Status`	`/installer/upgrade_status`	Get the status of a gateway or Energy Management Unit (EMU) upgrade.
`Upload`	`/installer/upload.json`	Upload a file to the gateway or Energy Management Unit (EMU).
`xapi`	`/installer/xapi`	Legacy API providing `api_version`, `upgrade_init`, `upgrade_status`, `restart_page_process`, `auxup` (start file upload server), `upgrade_start` (start an upgrade), `upgrade_resume` (resume an upgrade), `update_profile_key`, `upload` (upload a file).

IVP

IVP - Active Ripple Filter (ARF)

IVP - Active Ripple Filter (ARF) - Profile

IVP - Active Ripple Filter (ARF) - Profile - Multimode

Name	URI	Description
`Off Grid`	`/ivp/arf/profile/multimode/off_grid`	Get or set the profile for the multi-mode inverter when running off-grid.
`On Grid`	`/ivp/arf/profile/multimode/on_grid`	Get or set the profile for the multi-mode inverter when running on-grid.

IVP - Analog-to-Digital Converter (ADC)

IVP - Analog-to-Digital Converter (ADC) - Relaxed Parameters

Name	URI	Description
`Add Relaxed Parameters`	`/ivp/adc/relaxedparams/add`	Overrides M-Series Parameters.

IVP - Cellular

Name	URI	Description
`All Devices`	`/ivp/cellular`	Get all cellular devices information.
`Specific Device`	`/ivp/cellular/{EID}`	Get specific cellular device information.

IVP - EH

IVP - EH - Device Status (devs)

Name	URI	Description
`All Devices`	`/ivp/eh/devs`	Get all devices’ status (including microinverters and meters).
`Specific Device`	`/ivp/eh/devs/{EID}`	Get specific device’s status (of a microinverter, meter etc).

IVP - Energy System (formerly "Ensemble")

IVP - Energy System (formerly "Ensemble") - Data Raw

Name	URI	Description
`All Devices`	`/ivp/ensemble/dataraw/`	Get Enphase® Energy System (formerly "Ensemble") raw data for all devices.
`Specific Device`	`/ivp/ensemble/dataraw/{EID}`	Get Enphase® Energy System (formerly "Ensemble") raw data for a specific device.

IVP - Energy System (formerly "Ensemble") - General

Name	URI	Description
`Communication Check`	`/ivp/ensemble/comm_check`	IQ System Controller (formerly "Enpower") and IQ Battery (formerly "Encharge Storage") communication check.
`Decommission`	`/ivp/ensemble/decommission`	Delete an Enphase® Energy System (formerly "Ensemble") CAN device (3rd-Generation).
`Device List`	`/ivp/ensemble/device_list`	Get Enphase® Energy System (formerly "Ensemble") CAN device (3rd-Generation) status.
`Device Provision`	`/ivp/ensemble/device_provision`	Provision an Enphase® Energy System (formerly "Ensemble") CAN device.
`Device Status`	`/ivp/ensemble/device_status`	Get Enphase® Energy System (formerly "Ensemble") device status.
`Dry Contacts`	`/ivp/ensemble/dry_contacts`	Get or set the IQ System Controller (formerly "Enpower") dry contact status.
`EC1 Wiring Test`	`/ivp/ensemble/ec1_wiring_test`	Start or get the results of an IQ Battery (formerly "Encharge Storage") wiring test.
`Errors`	`/ivp/ensemble/errors`	Get or set the IQ System Controller (formerly "Enpower") error state.
`Generator Status`	`/ivp/ensemble/generator`	Get or set the IQ System Controller (formerly "Enpower") generator status.
`Generator Wiring Test`	`/ivp/ensemble/gen_wiring_test`	Start or get the results of the generator wiring test.
`Inventory`	`/ivp/ensemble/inventory`	Get Energy System (formerly "Ensemble") inventory.
`Profile Status`	`/ivp/ensemble/profile_status`	Get or set the Enphase® Energy System (formerly "Ensemble") Advanced Grid Functionality (AGF) profile status.
`Relay`	`/ivp/ensemble/relay`	Get the status of or toggle the grid relay.
`Reset Device`	`/ivp/ensemble/reset_device/{SERIAL_NUMBER}`	Reset a CAN device for IQ System Controller (formerly "Enpower") manual override.
`Sleep`	`/ivp/ensemble/sleep`	Get, set or cancel the IQ Battery (formerly "Encharge Storage") sleep mode.
`Status`	`/ivp/ensemble/status`	Get Enphase® Energy System (formerly "Ensemble") status.
`Submodules`	`/ivp/ensemble/submod`	Get Enphase® Energy System (formerly "Ensemble") submodules.
`Zigbee Security Control Messages`	`/ivp/ensemble/secctrl`	Get the Energy System (formerly "Ensemble") status using Zigbee Security Control (SecCtrl) messages.

IVP - Firmware Manager

Name	URI	Description
`Config`	`/ivp/firmware_manager/config`	Get or set Enphase® Energy System (formerly "Ensemble") Software (ESS) automatic update settings (and might be a typo but also meter configuration status?).
`State`	`/ivp/firmware_manager/state`	Get Enphase® Energy System (formerly "Ensemble") Software (ESS) update state.
`Update All`	`/ivp/firmware_manager/update_all`	Update all IQ System Controller (formerly "Enpower") and Enphase® Energy System (formerly "Ensemble") Software (ESS) devices.
`Update Single`	`/ivp/firmware_manager/update_single`	Update a single Enphase® Energy System (formerly "Ensemble") or IQ System Controller (formerly "Enpower") device.

IVP - Grid REST (GREST)

Name	URI	Description
`Profile`	`/ivp/grest/profile/G99-1-6%3A2020%20UK/1.2.10`	Display Advanced Grid Functionality (AGF) profile.
`Redetermine Phase`	`/ivp/grest/local/gs/redeterminephase`	Redetermine phase.

IVP - Live Data

Name	URI	Description
`Status`	`/ivp/livedata/status`	Get live data MQTT streaming status.
`Stream`	`/ivp/livedata/stream`	Enable or disable live data MQTT streaming.

IVP - Meters

IVP - Meters - Current Transformer (CT) Settings (CTS)

Name	URI	Description
`All Meters`	`/ivp/meters/cts`	Get meters’ Current Transformer (CT) clamp settings.
`Specific Meter`	`/ivp/meters/cts/{EID}`	Get or update specific meter’s Current Transformer (CT) clamp settings by Gateway (formerly "Envoy") record ID.

IVP - Meters - General

Name	URI	Description
`All Meters’ Settings`	`/ivp/meters`	Get or set internal meters’ settings.
`Specific Meter’s Current Transformer (CT) Reversal`	`/ivp/meters/ctreversal/{EID}`	Get or set specific meter’s Current Transformer (CT) clamp reverse polarity settings globally or by a meter identifier.
`Specific Meter’s Settings`	`/ivp/meters/{EID}`	Get or set a specific meter’s settings by Gateway (formerly "Envoy") record ID.
`Storage Setting`	`/ivp/meters/storage_setting`	Get or set the storage Current Transformer (CT) clamp status.

IVP - Meters - Readings

Name	URI	Description
`All Meters`	`/ivp/meters/readings`	Get readings from all the meters.
`Specific Meter`	`/ivp/meters/readings/{EID}`	Get specific meter’s readings by Gateway (formerly "Envoy") record ID.

IVP - Meters - Reports

Name	URI	Description
`All Meters`	`/ivp/meters/reports/`	Get readings from all the meters.
`Consumption Only`	`/ivp/meters/reports/consumption`	Get readings from the consumption meters.
`Production Only`	`/ivp/meters/reports/production`	Get readings from the production meters.

IVP - Mod

Name	URI	Description
`Power Mode`	`/ivp/mod/{EID}/mode/power`	Get or set the power production power state, where the Gateway (formerly "Envoy") record ID is hardcoded as `603980032`.

IVP - PCU ("Power Conditioning Unit") Envoy Bridge (PEB)

Name	URI	Description
`Device Status`	`/ivp/peb/devstatus`	Get device status.
`New Scan`	`/ivp/peb/newscan`	Start, stop or get the results of a new scan for devices.
`Report Settings`	`/ivp/peb/reportsettings`	Get or set the priority for reporting to Enphase® Cloud (formerly "Enlighten® Cloud").

IVP - Secondary Control (SC)

Name	URI	Description
`Scheduler Settings`	`/ivp/sc/sched`	Get or override Encharge charging/discharging status.
`Status`	`/ivp/sc/status`	Get Secondary Control (SC) status.

IVP - Site Settings (SS)

Name	URI	Description
`Device Power Export Limits (PEL) Settings`	`/ivp/ss/dpel`	Get or set Device Power Export Limit (PEL) settings (Legacy, replaced by AGF).
`Distributed Energy Resource (DER) Settings`	`/ivp/ss/der_settings`	Get or set Distributed Energy Resource (DER) settings.
`Dry Contact Settings`	`/ivp/ss/dry_contact_settings`	Get or set dry contact settings.
`Generator Configuration`	`/ivp/ss/gen_config`	Get or set generator configuration.
`Generator Delete`	`/ivp/ss/gen_delete`	Delete generator.
`Generator Meter Enable`	`/ivp/ss/generator_meter_enable`	Set generator meter state.
`Generator Mode`	`/ivp/ss/gen_mode`	Get or set generator’s status for toggle switch.
`Generator Profile`	`/ivp/ss/gen_profile`	Get or set generator’s profile.
`Generator Schedule`	`/ivp/ss/gen_schedule`	Get or set generator schedule.
`IQ Battery (formerly "Encharge") Settings`	`/ivp/ss/enc_settings`	Update IQ Battery (formerly "Encharge") settings.
`Load Control`	`/ivp/ss/load_control`	Add load control kits.
`Power Control System (PCS) Settings`	`/ivp/ss/pcs_settings`	Get or set Power Control System (PCS) details.
`Power Export Limits (PEL) Settings`	`/ivp/ss/pel_settings`	Get Power Export Limits (PEL) data.
`System Phase Balance`	`/ivp/ss/sys_phase_balance`	Send phase information.

IVP - Site Settings (SS) - Third Party (Legacy)

Name	URI	Description
`PV`	`/ivp/ss/third_party/pv`	Get, set or delete third-party PV information.

IVP - Trip Point Management (TPM) (Legacy)

Name	URI	Description
`Capability`	`/ivp/tpm/capability`	Trip Point Management (TPM) capability.
`Parameters`	`/ivp/tpm/parameters`	Trip Point Management (TPM) parameters.
`Select`	`/ivp/tpm/select`	Trip Point Management (TPM) select.
`TPM Status`	`/ivp/tpm/tpmstatus`	Trip Point Management (TPM) status.

IVP - Zigbee

Name	URI	Description
`Pairing Status`	`/ivp/zb/pairing_status`	Get Enphase® Energy System (formerly "Ensemble") Zigbee pairing status.
`Provision`	`/ivp/zb/provision`	Set or delete Enphase® Energy System (formerly "Ensemble") devices.
`Reset Device`	`/ivp/zb/reset_device`	Reset device for "IQ System Controller" (formerly "Enpower") manual override.
`Set Phase`	`/ivp/zb/set_phase`	Update IQ Battery (formerly "Encharge Storage") phase.
`Status`	`/ivp/zb/status`	Get Zigbee status.

Stream

Name	URI	Description
`Meter`	`/stream/meter`	Obtain a continuous stream of meter readings.
`Power Spectral Density (PSD)`	`/stream/psd`	Obtain a continuous stream of Power-Spectral-Density analysis of the Power-Line Communication (PLC).

Version 1 API (Legacy)

Name	URI	Description
`Inverter(s) Production (Version 1 API)`	`/api/v1/production/inverters`	Obtain the legacy microinverter energy production information.